<!doctype html>
<html class="default no-js">
<head>
	<meta charset="utf-8">
	<meta http-equiv="X-UA-Compatible" content="IE=edge">
	<title>jsonpath-plus</title>
	<meta name="description" content="Documentation for jsonpath-plus">
	<meta name="viewport" content="width=device-width, initial-scale=1">
	<link rel="stylesheet" href="assets/css/main.css">
	<script async src="assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
	<div class="tsd-page-toolbar">
		<div class="container">
			<div class="table-wrap">
				<div class="table-cell" id="tsd-search" data-index="assets/js/search.json" data-base=".">
					<div class="field">
						<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
						<input id="tsd-search-field" type="text" />
					</div>
					<ul class="results">
						<li class="state loading">Preparing search index...</li>
						<li class="state failure">The search index is not available</li>
					</ul>
					<a href="index.html" class="title">jsonpath-plus</a>
				</div>
				<div class="table-cell" id="tsd-widgets">
					<div id="tsd-filter">
						<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
						<div class="tsd-filter-group">
							<div class="tsd-select" id="tsd-filter-visibility">
								<span class="tsd-select-label">All</span>
								<ul class="tsd-select-list">
									<li data-value="public">Public</li>
									<li data-value="protected">Public/Protected</li>
									<li data-value="private" class="selected">All</li>
								</ul>
							</div>
							<input type="checkbox" id="tsd-filter-inherited" checked />
							<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
						</div>
					</div>
					<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
				</div>
			</div>
		</div>
	</div>
	<div class="tsd-page-title">
		<div class="container">
			<h1>jsonpath-plus</h1>
		</div>
	</div>
</header>
<div class="container container-main">
	<div class="row">
		<div class="col-8 col-content">
			<section class="tsd-panel-group tsd-index-group">
				<h2>Index</h2>
				<section class="tsd-panel tsd-index-panel">
					<div class="tsd-index-content">
						<section class="tsd-index-section ">
							<h3>Classes</h3>
							<ul class="tsd-index-list">
								<li class="tsd-kind-class"><a href="classes/jsonpathclass.html" class="tsd-kind-icon">JSONPath<wbr>Class</a></li>
							</ul>
						</section>
						<section class="tsd-index-section ">
							<h3>Interfaces</h3>
							<ul class="tsd-index-list">
								<li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/jsonpathcallable.html" class="tsd-kind-icon">JSONPath<wbr>Callable</a></li>
								<li class="tsd-kind-interface"><a href="interfaces/jsonpathoptions.html" class="tsd-kind-icon">JSONPath<wbr>Options</a></li>
								<li class="tsd-kind-interface"><a href="interfaces/jsonpathoptionsautostart.html" class="tsd-kind-icon">JSONPath<wbr>Options<wbr>Auto<wbr>Start</a></li>
							</ul>
						</section>
						<section class="tsd-index-section ">
							<h3>Type aliases</h3>
							<ul class="tsd-index-list">
								<li class="tsd-kind-type-alias"><a href="modules.html#jsonpathcallback" class="tsd-kind-icon">JSONPath<wbr>Callback</a></li>
								<li class="tsd-kind-type-alias"><a href="modules.html#jsonpathothertypecallback" class="tsd-kind-icon">JSONPath<wbr>Other<wbr>Type<wbr>Callback</a></li>
								<li class="tsd-kind-type-alias"><a href="modules.html#jsonpathtype" class="tsd-kind-icon">JSONPath<wbr>Type</a></li>
							</ul>
						</section>
						<section class="tsd-index-section ">
							<h3>Variables</h3>
							<ul class="tsd-index-list">
								<li class="tsd-kind-variable"><a href="modules.html#jsonpath" class="tsd-kind-icon">JSONPath</a></li>
							</ul>
						</section>
					</div>
				</section>
			</section>
			<section class="tsd-panel-group tsd-member-group ">
				<h2>Type aliases</h2>
				<section class="tsd-panel tsd-member tsd-kind-type-alias">
					<a name="jsonpathcallback" class="tsd-anchor"></a>
					<h3>JSONPath<wbr>Callback</h3>
					<div class="tsd-signature tsd-kind-icon">JSONPath<wbr>Callback<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>payload<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, payloadType<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, fullPayload<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">any</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/brettz9/JSONPath/blob/3b60ae3/src/jsonpath.d.ts#L5">jsonpath.d.ts:5</a></li>
						</ul>
					</aside>
					<div class="tsd-type-declaration">
						<h4>Type declaration</h4>
						<ul class="tsd-parameters">
							<li class="tsd-parameter-signature">
								<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias">
									<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>payload<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, payloadType<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, fullPayload<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
								</ul>
								<ul class="tsd-descriptions">
									<li class="tsd-description">
										<h4 class="tsd-parameters-title">Parameters</h4>
										<ul class="tsd-parameters">
											<li>
												<h5>payload: <span class="tsd-signature-type">any</span></h5>
											</li>
											<li>
												<h5>payloadType: <span class="tsd-signature-type">any</span></h5>
											</li>
											<li>
												<h5>fullPayload: <span class="tsd-signature-type">any</span></h5>
											</li>
										</ul>
										<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
									</li>
								</ul>
							</li>
						</ul>
					</div>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-type-alias">
					<a name="jsonpathothertypecallback" class="tsd-anchor"></a>
					<h3>JSONPath<wbr>Other<wbr>Type<wbr>Callback</h3>
					<div class="tsd-signature tsd-kind-icon">JSONPath<wbr>Other<wbr>Type<wbr>Callback<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/brettz9/JSONPath/blob/3b60ae3/src/jsonpath.d.ts#L9">jsonpath.d.ts:9</a></li>
						</ul>
					</aside>
					<div class="tsd-type-declaration">
						<h4>Type declaration</h4>
						<ul class="tsd-parameters">
							<li class="tsd-parameter-signature">
								<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias">
									<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
								</ul>
								<ul class="tsd-descriptions">
									<li class="tsd-description">
										<h4 class="tsd-parameters-title">Parameters</h4>
										<ul class="tsd-parameters">
											<li>
												<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5>
											</li>
										</ul>
										<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
									</li>
								</ul>
							</li>
						</ul>
					</div>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-type-alias">
					<a name="jsonpathtype" class="tsd-anchor"></a>
					<h3>JSONPath<wbr>Type</h3>
					<div class="tsd-signature tsd-kind-icon">JSONPath<wbr>Type<span class="tsd-signature-symbol">:</span> <a href="interfaces/jsonpathcallable.html" class="tsd-signature-type" data-tsd-kind="Interface">JSONPathCallable</a><span class="tsd-signature-symbol"> &amp; </span><a href="classes/jsonpathclass.html" class="tsd-signature-type" data-tsd-kind="Class">JSONPathClass</a></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/brettz9/JSONPath/blob/3b60ae3/src/jsonpath.d.ts#L193">jsonpath.d.ts:193</a></li>
						</ul>
					</aside>
				</section>
			</section>
			<section class="tsd-panel-group tsd-member-group ">
				<h2>Variables</h2>
				<section class="tsd-panel tsd-member tsd-kind-variable">
					<a name="jsonpath" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagConst">Const</span> JSONPath</h3>
					<div class="tsd-signature tsd-kind-icon">JSONPath<span class="tsd-signature-symbol">:</span> <a href="modules.html#jsonpathtype" class="tsd-signature-type" data-tsd-kind="Type alias">JSONPathType</a></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/brettz9/JSONPath/blob/3b60ae3/src/jsonpath.d.ts#L195">jsonpath.d.ts:195</a></li>
						</ul>
					</aside>
				</section>
			</section>
		</div>
		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
			<nav class="tsd-navigation primary">
				<ul>
					<li class="current ">
						<a href="modules.html">Exports</a>
					</li>
				</ul>
			</nav>
			<nav class="tsd-navigation secondary menu-sticky">
				<ul class="before-current">
					<li class=" tsd-kind-class">
						<a href="classes/jsonpathclass.html" class="tsd-kind-icon">JSONPath<wbr>Class</a>
					</li>
					<li class=" tsd-kind-interface tsd-has-type-parameter">
						<a href="interfaces/jsonpathcallable.html" class="tsd-kind-icon">JSONPath<wbr>Callable</a>
					</li>
					<li class=" tsd-kind-interface">
						<a href="interfaces/jsonpathoptions.html" class="tsd-kind-icon">JSONPath<wbr>Options</a>
					</li>
					<li class=" tsd-kind-interface">
						<a href="interfaces/jsonpathoptionsautostart.html" class="tsd-kind-icon">JSONPath<wbr>Options<wbr>Auto<wbr>Start</a>
					</li>
					<li class=" tsd-kind-type-alias">
						<a href="modules.html#jsonpathcallback" class="tsd-kind-icon">JSONPath<wbr>Callback</a>
					</li>
					<li class=" tsd-kind-type-alias">
						<a href="modules.html#jsonpathothertypecallback" class="tsd-kind-icon">JSONPath<wbr>Other<wbr>Type<wbr>Callback</a>
					</li>
					<li class=" tsd-kind-type-alias">
						<a href="modules.html#jsonpathtype" class="tsd-kind-icon">JSONPath<wbr>Type</a>
					</li>
					<li class=" tsd-kind-variable">
						<a href="modules.html#jsonpath" class="tsd-kind-icon">JSONPath</a>
					</li>
				</ul>
			</nav>
		</div>
	</div>
</div>
<footer class="with-border-bottom">
	<div class="container">
		<h2>Legend</h2>
		<div class="tsd-legend-group">
			<ul class="tsd-legend">
				<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
				<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
			</ul>
		</div>
	</div>
</footer>
<div class="container tsd-generator">
	<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="assets/js/main.js"></script>
</body>
</html>